Upd readme
authorJeroen van der Heijden <jeroen@transceptor.technology>
Fri, 12 Oct 2018 17:01:19 +0000 (19:01 +0200)
committerJeroen van der Heijden <jeroen@transceptor.technology>
Fri, 12 Oct 2018 17:01:19 +0000 (19:01 +0200)
README.md
debian/changelog
main.c

index dffb63563d952322274e116747bff3ba64429b92..a74091eb969b734f854cfe94d73703325dc9844d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,6 +9,8 @@ SiriDB is a highly-scalable, robust and super fast time series database.
       * [Linux](#linux)
       * [OSX](#osx)
       * [Configuration](#configuration)
+    * [Build Debian package](#build-debian-package)
+    * [Run integration tests](#run-integration-tests)
   * [Create or expand a database](#create-or-expand-a-database)
   * [Using SiriDB](#using-siridb)
     * [SiriDB Connectors](#siridb-connectors)
@@ -47,17 +49,10 @@ Compile (replace Release with Debug for a debug build):
 ```
 cd ./Release
 make clean
+make test
 make
 ```
 
-Build Debian packages:
-
-```
-apt-get install devscripts lintian
-git archive -o ../siridb-server_2.0.29.orig.tar.gz master
-debuild -us -uc
-```
-
 #### OSX
 Install the following requirements:
 ```
@@ -71,18 +66,54 @@ cd ./Release
 export CFLAGS="-I/usr/local/include"
 export LDFLAGS="-L/usr/local/lib"
 make clean
+make test
 make
 ```
+
 #### Configuration
 SiriDB requires a configuration file to run. By default SiriDB will search for the configuration file in `/etc/siridb/siridb.conf` but alternatively you can specify a custom path by using the `-c/--config` argument.
 
 ```
 $ siridb-server -c /my/path/siridb.conf
 ```
-
 An example configuration file can be found here:
 [https://github.com/SiriDB/siridb-server/blob/master/siridb.conf](https://github.com/SiriDB/siridb-server/blob/master/siridb.conf)
 
+### Build Debian package:
+
+Install required packages (*autopkgtest is required for running the tests*)
+```
+apt-get install devscripts lintian help2man autopkgtest
+```
+
+Create archive
+```
+git archive -o ../siridb-server_2.0.30.orig.tar.gz master
+```
+
+Run tests
+```
+autopkgtest -B -- null
+```
+
+Build package
+```
+debuild -us -uc
+```
+
+## Run integration tests
+The simplest way to run the integration tests is to use [docker](https://docs.docker.com/install/).
+
+Build integration test image
+```
+docker build -t siridb/itest -f itest/Dockerfile .
+```
+
+Run integration tests
+```
+docker run siridb/itest:latest
+```
+
 ## Create or expand a database
 [SiriDB Admin](https://github.com/SiriDB/siridb-admin) is required for creating a new database or expanding an existing database with a new server. Documentation on how to install and use the admin tool can be found at the [siridb-admin](https://github.com/SiriDB/siridb-admin#readme) github project. Binaries are available for most platforms and can be downloaded from [here](https://github.com/SiriDB/siridb-admin/releases/latest).
 
@@ -109,14 +140,3 @@ When not using one of the above, you can still communicate to SiriDB using [Siri
 
 ## Query language
 Documentation about the query language can be found at https://siridb.net/documentation.
-
-## Integration testing
-Build integration test image
-```
-docker build -t siridb/itest -f itest/Dockerfile .
-```
-
-Run integration tests
-```
-docker run siridb/itest:latest
-```
\ No newline at end of file
index cf2cc564576fe5ae441a75bb22b2a19f85914d16..79f64e0202b3d20af640d3b886c8e7ce4f0bb0dd 100644 (file)
@@ -1,9 +1,3 @@
-siridb-server (2.0.30-alpha2) unstable; urgency=medium
-
-  * Test
-
- -- Jeroen van der Heijden <jeroen@transceptor.technology>  Fri, 12 Oct 2018 16:05:40 +0200
-
 siridb-server (2.0.29-1) unstable; urgency=medium
 
   * New upstream release
diff --git a/main.c b/main.c
index 085004dbd07376bf12d45e26cca67c26d10a62b1..2d55d7590893cfc8eae17f15f85bedc7a863f999 100644 (file)
--- a/main.c
+++ b/main.c
 
 int main(int argc, char * argv[])
 {
-    /*
-     * set local to LC_ALL
-     * more info at: http://www.cprogramming.com/tutorial/unicode.html
-     */
+    /* set local to LC_ALL */
     (void) setlocale(LC_ALL, "");
 
     /* initialize random */